CLI v2: OAuth, JSON output, and automation-first overhaul by nicped · Pull Request #47 · dynamicweb/CLI

nicped · 2026-04-13T15:34:09Z

Summary

OAuth client_credentials authentication — new --oauth login flow, --auth flag to override auth mode, env-var-based client credentials (--clientIdEnv/--clientSecretEnv)
Structured JSON output — --output json across all commands with consistent response envelope (ok, status, data, errors, meta), replacing the deprecated --json flag
File operations — --delete, --copy, --move support with --asFile/--asDirectory overrides and interactive confirmation for destructive actions
Code quality — output.finish() via finally blocks, extracted isFilePath helper, encapsulated meta access in output objects, verbose logging for archive cleanup errors, fixed missing output parameter threading through setupEnv/interactiveEnv/interactiveOAuthLogin
Documentation — full v2 documentation article, changelog, updated README

QA test scripts

To run the unit tests:

npm test

For QA to run the test smoke harness against a real solution:

export DW_BASE_URL=https://your-solution.example.com
export DW_CLIENT_ID=your-client-id
export DW_CLIENT_SECRET=your-client-secret
npm run qa:smoke

Full instructions (profile format, CI usage, --mode flag, etc.) are in qa/README.md.
https://github.com/dynamicweb/CLI/blob/7ce694f8464dd53c659f26d1950d6fc947b8aebd/qa/README.md

Test plan

Run dw with no args — verify environment status display, including when env is missing
Run dw login --oauth — verify interactive OAuth setup stores config correctly
Run dw query <name> --output json — verify clean JSON output with no console noise
Run dw files --delete <path> — verify confirmation prompt and correct API call
Run dw files --copy <src> --output json — verify JSON envelope
Run dw files --export <path> -v — verify verbose log shows correct operation context
Verify --output json and --interactive conflict on the query command
Verify deprecated --json flag on files command emits warning and still works

…neric, UserStory: 8747

…m one by one without the user having to specify them

…roperly use the structure in main

Suggestion to code highlight command parameters

New -i flag for files

…odel: data }

…ven, so given commands will have to follow the proper command structure instead of only supplying a model

Changing where we send form data to now send the new structure

Reflects page delete example properly, fixes #10

Fixes #5

Fixes #6

Fixes #4

Fixes #8

Adding proper content-type header for database command

Enable raw flag functionality for files

Adding short explanation of what the CLI is and can be used for in simpler terms.

Copilot

Pull request overview

This PR introduces a v2/beta overhaul of the DynamicWeb CLI focused on automation-first usage: OAuth client-credentials authentication, consistent --output json envelopes across API-driven commands, expanded file operations (delete/copy/move), and updated documentation/changelog to reflect the new behaviors.

Changes:

Add OAuth client-credentials support (--auth oauth, dw login --oauth, env-var based client ID/secret) and surface auth type in the base dw command.
Add structured JSON output (--output json, deprecated --json) to env, login, files, query, and command.
Expand dw files with destructive/mutating operations (--delete, --empty, --copy, --move) and update docs/README/changelog for v2.

Reviewed changes

Copilot reviewed 4 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
README.md	Rewrites README for v2 beta: OAuth, JSON output, files workflows, CI/CD guidance.
package.json	Bumps version to `2.0.0-beta.0`.
package-lock.json	Updates lockfile version metadata to `2.0.0-beta.0`.
cliv2-documentation.md	Adds full v2 documentation article covering auth, JSON envelopes, command refs.
CHANGELOG.md	Adds v2 beta changelog entries for breaking changes/features/improvements.
bin/index.js	Adds global OAuth flags and improves base command display (incl. auth type).
bin/commands/env.js	Adds `--output json` support and restructures env command output/error handling.
bin/commands/login.js	Adds OAuth login/config flow and JSON envelope support.
bin/commands/query.js	Adds `--output json`, structured output envelope, and improved error propagation.
bin/commands/command.js	Adds `--output json` and structured output envelope.
bin/commands/files.js	Adds JSON output, deprecated flag aliases, and new delete/copy/move operations.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…de, improve error handling - Login: block interactive prompts in JSON mode; add non-interactive OAuth login path; always apply --host override on existing environments - Files: skip full-export confirmation in JSON mode - Command: throw error for unimplemented --list instead of returning string - Login: extract shared OAuth finalization into finalizeOAuthLogin helper - Install: add JSON output example to README for documentation consistency - Docs: include install in --output json command lists

…ion into env.js

Patch release fixing TypeError in uploadFiles when called from install command without a structured output object.

Fix/install output envelope

…or testability - Export parseHostInput, getQueryParams, buildInteractiveQueryParams, buildQueryParamsFromArgv, extractQueryPropertyPrompts, getFieldNameFromPropertyPrompt, parseCookies, shouldUseOAuth, resolveOAuthConfig, prepareDownloadCommandData, isFilePath, wildcardToRegExp, getFilesOperation from their respective modules - Add setConfigForTests() to config.js and guard getConfig() against null return - Inject deps (interactiveEnvFn, getPropertiesFn, promptFn) via optional deps param in setupEnv and getQueryParams for easier unit testing - Add test/ suite covering command, env, files, login, query, and utility helpers - Add qa/ smoke harness (run-smoke.mjs) with fixtures, profile.example.json, and README covering saved-env and ephemeral CI flows against a real DynamicWeb solution - Wire npm run test (node --test) and npm run qa:smoke scripts in package.json - Bump version to 2.0.0-beta.1 - Ignore qa/artifacts/ and qa/profile.json in .gitignore

…files; add tests for JSON parsing and formatting functions

MrBuhl · 2026-04-22T09:48:06Z

Setup: Latest master build of dw10 running locally through IIS:
Can't get "dw login --oauth" to work

User exists, is administrator and active

Creating an OAuth client in backend and passing info to login like
dw login local --auth --clientIdEnv=f28be14b144f4d138671fd8991adea01 --clientSecretEnv=3bb3d0b2f7e549ca9f3450790c8775163f0b4ff5d4334d6e9f2b848b21bf2cb2045cc82fea7848a6b998a42dea7a13ef
fails with
file:///C:/Users/mbp/AppData/Roaming/npm/node_modules/@dynamicweb/cli/bin/commands/login.js:216
getConfig().env[getConfig().current.env].current.user = argv.user;
^

TypeError: Cannot set properties of undefined (setting 'user')
at changeUser (file:///C:/Users/mbp/AppData/Roaming/npm/node_modules/@dynamicweb/cli/bin/commands/login.js:216:59)
at handleLogin (file:///C:/Users/mbp/AppData/Roaming/npm/node_modules/@dynamicweb/cli/bin/commands/login.js:63:17)
at Object.handler (file:///C:/Users/mbp/AppData/Roaming/npm/node_modules/@dynamicweb/cli/bin/commands/login.js:16:28)
at C:\Users\mbp\AppData\Roaming\npm\node_modules@dynamicweb\cli\node_modules\yargs\build\index.cjs:1:8993
at j (C:\Users\mbp\AppData\Roaming\npm\node_modules@dynamicweb\cli\node_modules\yargs\build\index.cjs:1:4956)
at _.handleValidationAndGetResult (C:\Users\mbp\AppData\Roaming\npm\node_modules@dynamicweb\cli\node_modules\yargs\build\index.cjs:1:8962)
at _.applyMiddlewareAndGetResult (C:\Users\mbp\AppData\Roaming\npm\node_modules@dynamicweb\cli\node_modules\yargs\build\index.cjs:1:9604)
at _.runCommand (C:\Users\mbp\AppData\Roaming\npm\node_modules@dynamicweb\cli\node_modules\yargs\build\index.cjs:1:7231)
at [runYargsParserAndExecuteCommands] (C:\Users\mbp\AppData\Roaming\npm\node_modules@dynamicweb\cli\node_modules\yargs\build\index.cjs:1:58539)
at te.parse (C:\Users\mbp\AppData\Roaming\npm\node_modules@dynamicweb\cli\node_modules\yargs\build\index.cjs:1:40478)

Node.js v22.22.1

Test script example is in bash format. We should probably use powershell for documentation, where it would be:
$env:DW_BASE_URL = "your-url"
$env:DW_CLIENT_ID = "your-client-id"
$env:DW_CLIENT_SECRET = "your-client-secret"
npm run qa:smoke

Anyway running test script (both in powershell or bash through wsl) fails with
Running saved-environment flow...
FAIL saved-env: seed config: saved-env-config exited with code 1. file:///C:/source/CLI/bin/commands/files.js:746
async function parseJsonSafe(res) {
^

SyntaxError: Identifier 'parseJsonSafe' has already been declared
at compileSourceTextModule (node:internal/modules/esm/utils:346:16)
at ModuleLoader.moduleStrategy (node:internal/modules/esm/translators:107:18)
at #translate (node:internal/modules/esm/loader:546:20)
at afterLoad (node:internal/modules/esm/loader:596:29)
at ModuleLoader.loadAndTranslate (node:internal/modules/esm/loader:601:12)
at #createModuleJob (node:internal/modules/esm/loader:624:36)
at #getJobFromResolveResult (node:internal/modules/esm/loader:343:34)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:311:41)

Node.js v22.22.1
QA smoke run failed: saved-env-config exited with code 1. file:///C:/source/CLI/bin/commands/files.js:746
async function parseJsonSafe(res) {

…strap, and QA docs - Remove duplicate parseJsonSafe declaration in files.js (caused SyntaxError on startup) - Allow dw login --oauth --host to work from a clean state by deriving env name from hostname - Guard finalizeOAuthLogin against undefined env entry in config - Add PowerShell env var instructions to qa/README.md

…ommand outputs

…0.0-preview.1

Introduces `dw folders <folderPath>` for unambiguous directory management: --create and --rename via DirectorySave, --move via DirectoryMove, --delete/--copy/--export routed through handleFiles (now exported). Updates README and cliv2-documentation with full command reference.

MrBuhl · 2026-05-01T10:57:07Z

With latest changes the qa smoke suite now runs with env var based login.

Still cant get --oauth flow to do anything and any files commands fail as they trigger a login flow and fail

…fter interactive login

nicped · 2026-05-04T06:59:12Z

--oauth was only implemented for login command - that would then create the dwc. If running --auth oauth it would work on any command
I have now added so any command supports --oauth directly.

…ation

frederik5480 and others added 30 commits August 19, 2022 15:00

Create README.md

ed74ff5

Fixing bug in login command, adding query and command commands for ge…

eb1bfa7

…neric, UserStory: 8747

Added interactive mode for queries, this will ask for each query para…

8154759

…m one by one without the user having to specify them

Updating readme

cf36e84

Removing latest option from swift, adding nightly option to swift

fdd6ca3

Files are now being unzipped when extracting them

05268d5

Fixing extract bug and changing addinprovider in install command to p…

85d99fb

…roperly use the structure in main

Suggestion to code highlight command parameters

ad789a4

Fix missing

c2f0aba

Merge pull request #1 from dynamicweb/parameter-highlight-in-readme

d79c7c9

Suggestion to code highlight command parameters

Moving uploadFile to files, adding flag to use with file and destination

967a6fa

Merge pull request #2 from dynamicweb/feature/import-files

ca55895

New -i flag for files

Changing where we send form data to now send the new structure of { m…

0afd0b3

…odel: data }

Changing back the command command to simply just use the structure gi…

4f6dd0a

…ven, so given commands will have to follow the proper command structure instead of only supplying a model

Merge pull request #3 from dynamicweb/sending-json-over-formdata

af72b77

Changing where we send form data to now send the new structure

Update readme.md to reflect the management API json changes

a708b72

Fixes #8

e645f23

Updated readme.md

bf1c74a

Reflects page delete example properly, fixes #10

Update readme.md

6b7b56a

Fixes #5

Update readme.me

fec28e9

Fixes #6

Fixes #4

ea6133b

Fixes #7

9171a1c

Merge pull request #13 from dynamicweb/bugfix/swift-out-path

724e5df

Fixes #4

Merge pull request #12 from dynamicweb/files-exporting-fix

e6db820

Fixes #8

Adding proper content-type header for database command

f68bdea

Merge pull request #16 from dynamicweb/database-command-json-header

3961bc9

Adding proper content-type header for database command

Fixes #15

1d6b9cd

Merge pull request #17 from dynamicweb/export-files-raw

903d571

Enable raw flag functionality for files

Update README.md

a07e7c8

Adding short explanation of what the CLI is and can be used for in simpler terms.

Fixing directory and file listing query not working

e374b6d

nicped added 2 commits April 13, 2026 17:20

Add changelog and what's new section for v2

9b366ed

Refactor command handling and improve output logging across CLI commands

3fd5ce9

nicped requested a review from Copilot April 13, 2026 15:34

Copilot started reviewing on behalf of nicped April 13, 2026 15:35 View session

nicped mentioned this pull request Apr 13, 2026

Missing consistent return data #36

Open

Copilot AI reviewed Apr 13, 2026

View reviewed changes

Comment thread CHANGELOG.md

nicped added 11 commits April 13, 2026 22:58

Refactor command error handling: consolidate createCommandError funct…

472778d

…ion into env.js

Update Swift version in documentation examples to v2.3.0

a7c20e2

Add CLAUDE.md for project documentation and enhance file upload logging

4219653

Fix install upload output handling

5474983

Bump version to 1.1.2

a08d5ea

Patch release fixing TypeError in uploadFiles when called from install command without a structured output object.

Merge pull request #48 from dynamicweb/fix/install-output-envelope

b8b7758

Fix/install output envelope

Refactor command handling and improve error handling across multiple …

5623304

…files; add tests for JSON parsing and formatting functions

Bump version

7017369

Merge branch 'main' into v2

a4b5de5

nicped assigned MrBuhl Apr 15, 2026

Update README to clarify CLI functionality and improve tool comparison

48fb464

nicped added 5 commits April 22, 2026 16:25

Bump version to 2.0.0-preview.1 and switch status codes from HTTP to 0/1

da460b4

Update README to reflect status code changes from HTTP 200 to 0 for c…

5a88a21

…ommand outputs

Update README to reflect branch target change from 2.0.0-beta.0 to 2.…

3361360

…0.0-preview.1

Fix --oauth not recognized on non-login commands and stale env read a…

35314f0

…fter interactive login

Add support for --oauth option for OAuth client credentials authentic…

3852e9f

…ation

nicped force-pushed the v2 branch from 05dd114 to 3852e9f Compare May 5, 2026 06:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CLI v2: OAuth, JSON output, and automation-first overhaul#47

CLI v2: OAuth, JSON output, and automation-first overhaul#47
nicped wants to merge 120 commits into
mainfrom
v2

nicped commented Apr 13, 2026 •

edited by MrBuhl

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

MrBuhl commented Apr 22, 2026

Uh oh!

MrBuhl commented May 1, 2026

Uh oh!

nicped commented May 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

nicped commented Apr 13, 2026 • edited by MrBuhl Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

QA test scripts

Test plan

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

MrBuhl commented Apr 22, 2026

Uh oh!

MrBuhl commented May 1, 2026

Uh oh!

nicped commented May 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

nicped commented Apr 13, 2026 •

edited by MrBuhl

Loading